Docs: Tweaks
authorMatthias Clasen <mclasen@redhat.com>
Sat, 5 Jun 2021 21:36:02 +0000 (17:36 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 5 Jun 2021 21:38:23 +0000 (17:38 -0400)
Remove some more redundant "or NULL" blurbs.

gdk/gdk.c
gdk/gdkcursor.c
gdk/gdkdisplay.c
gdk/gdkdisplaymanager.c
gdk/gdkframeclock.c

index f3e2336f50019279e29f21fc338608a452541c91..b3a569d34da226cf91a4ccc2d4fc21c867f9fc8b 100644 (file)
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -330,14 +330,13 @@ gdk_display_open_default (void)
 }
 
 /*< private >
- *
- * gdk_get_startup_notification_id
+ * gdk_get_startup_notification_id:
  *
  * Returns the original value of the DESKTOP_STARTUP_ID environment
  * variable if it was defined and valid, or %NULL otherwise.
  *
  * Returns: (nullable) (transfer none): the original value of the
- *   DESKTOP_STARTUP_ID environment variable, or %NULL.
+ *   DESKTOP_STARTUP_ID environment variable
  */
 const char *
 gdk_get_startup_notification_id (void)
index 1c9fc9b4b1b42aa069808d78b9ef0ae5678ae007..3534eee8084d14cf2befefee2acd1c997f5fe37d 100644 (file)
@@ -340,7 +340,7 @@ gdk_cursor_new_from_name (const char *name,
  * @texture: the texture providing the pixel data
  * @hotspot_x: the horizontal offset of the “hotspot” of the cursor
  * @hotspot_y: the vertical offset of the “hotspot” of the cursor
- * @fallback: (nullable): %NULL or the `GdkCursor` to fall back to when
+ * @fallback: (nullable): the `GdkCursor` to fall back to when
  *   this one cannot be supported
  *
  * Creates a new cursor from a `GdkTexture`.
index 0def0da75cc60391e15bdbcb1a5b9b97c29efd5a..690d21f8350657c3aab6bdbcbb512803848b047c 100644 (file)
@@ -384,11 +384,11 @@ gdk_display_is_closed  (GdkDisplay  *display)
  * gdk_display_get_event:
  * @display: a `GdkDisplay`
  *
- * Gets the next `GdkEvent` to be processed for @display, fetching events from the
- * windowing system if necessary.
+ * Gets the next `GdkEvent` to be processed for @display,
+ * fetching events from the windowing system if necessary.
  *
- * Returns: (nullable) (transfer full): the next `GdkEvent` to be processed,
- *   or %NULL if no events are pending
+ * Returns: (nullable) (transfer full): the next `GdkEvent`
+ *   to be processed
  */
 GdkEvent *
 gdk_display_get_event (GdkDisplay *display)
index 6935f7ada970ddeef7c1753b2e9fe06b761859a9..557444ff1c46ca7393dcf54673d1e9899b12fe87 100644 (file)
@@ -323,7 +323,8 @@ gdk_display_manager_get_default_display (GdkDisplayManager *manager)
  * Gets the default `GdkDisplay`.
  *
  * This is a convenience function for:
- * `gdk_display_manager_get_default_display (gdk_display_manager_get ())`.
+ *
+ *     gdk_display_manager_get_default_display (gdk_display_manager_get ())
  *
  * Returns: (nullable) (transfer none): a `GdkDisplay`, or %NULL if
  *   there is no default display
index 296230f963e63d3e3aae6d0a04ddaad1ef4cc8ee..6f75e13620554a3cc4403a1acbda3516824fafb5 100644 (file)
@@ -481,11 +481,11 @@ _gdk_frame_clock_begin_frame (GdkFrameClock *frame_clock)
  * for the current frame or a recent frame.
  *
  * The `GdkFrameTimings` object may not yet be complete: see
- * [method@Gdk.FrameTimings.get_complete].
+ * [method@Gdk.FrameTimings.get_complete] and
+ * [method@Gdk.FrameClock.get_history_start].
  *
  * Returns: (nullable) (transfer none): the `GdkFrameTimings` object
- *   for the specified frame, or %NULL if it is not available. See
- *   [method@Gdk.FrameClock.get_history_start].
+ *   for the specified frame, or %NULL if it is not available
  */
 GdkFrameTimings *
 gdk_frame_clock_get_timings (GdkFrameClock *frame_clock,